<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python documentation Index' />
<link rel="first" href="lib.html" title='Python library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="module-wave.html" />
<link rel="prev" href="module-aifc.html" />
<link rel="parent" href="mmedia.html" />
<link rel="next" href="au-read-objects.html" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name='aesop' content='information' />
<title>19.4 sunau -- Read and write Sun AU files</title>
</head>
<body>
<div class="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="19.3 aifc  "
  href="module-aifc.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="19. multimedia Services"
  href="mmedia.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="19.4.1 au_read Objects"
  href="au-read-objects.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-aifc.html">19.3 aifc  </a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="mmedia.html">19. Multimedia Services</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="au-read-objects.html">19.4.1 AU_read Objects</a>
</div>
<hr /></div>
</div>
<!--End of Navigation Panel-->

<h1><a name="SECTION0021400000000000000000">
19.4 <tt class="module">sunau</tt> --
         Read and write Sun AU files</a>
</h1>

<p>
<a name="module-sunau"></a>

<p>
The <tt class="module">sunau</tt> module provides a convenient interface to the Sun
AU sound format.  Note that this module is interface-compatible with
the modules <tt class="module"><a href="module-aifc.html">aifc</a></tt> and <tt class="module"><a href="module-wave.html">wave</a></tt>.

<p>
An audio file consists of a header followed by the data.  The fields
of the header are:

<p>
<div class="center"><table class="realtable">
  <thead>
    <tr>
      <th class="left"  >Field</th>
      <th class="left"  >Contents</th>
      </tr>
    </thead>
  <tbody>
    <tr><td class="left"   valign="baseline">magic word</td>
        <td class="left"  >The four bytes "<tt class="samp">.snd</tt>".</td></tr>
    <tr><td class="left"   valign="baseline">header size</td>
        <td class="left"  >Size of the header, including info, in bytes.</td></tr>
    <tr><td class="left"   valign="baseline">data size</td>
        <td class="left"  >Physical size of the data, in bytes.</td></tr>
    <tr><td class="left"   valign="baseline">encoding</td>
        <td class="left"  >Indicates how the audio samples are encoded.</td></tr>
    <tr><td class="left"   valign="baseline">sample rate</td>
        <td class="left"  >The sampling rate.</td></tr>
    <tr><td class="left"   valign="baseline"># of channels</td>
        <td class="left"  >The number of channels in the samples.</td></tr>
    <tr><td class="left"   valign="baseline">info</td>
        <td class="left"  >ASCII string giving a description of the audio
                file (padded with null bytes).</td></tr></tbody>
</table></div>

<p>
Apart from the info field, all header fields are 4 bytes in size.
They are all 32-bit unsigned integers encoded in big-endian byte
order.

<p>
The <tt class="module">sunau</tt> module defines the following functions:

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4562' xml:id='l2h-4562' class="function">open</tt></b>(</nobr></td>
  <td><var>file, mode</var>)</td></tr></table></dt>
<dd>
If <var>file</var> is a string, open the file by that name, otherwise treat it
as a seekable file-like object. <var>mode</var> can be any of
<dl>
<dt><strong><code>'r'</code></strong></dt>
<dd>Read only mode.
	
</dd>
<dt><strong><code>'w'</code></strong></dt>
<dd>Write only mode.
</dd>
</dl>
Note that it does not allow read/write files.

<p>
A <var>mode</var> of <code>'r'</code> returns a <tt class="class">AU_read</tt>
object, while a <var>mode</var> of <code>'w'</code> or <code>'wb'</code> returns
a <tt class="class">AU_write</tt> object.
</dl>

<p>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
  <td><nobr><b><tt id='l2h-4563' xml:id='l2h-4563' class="function">openfp</tt></b>(</nobr></td>
  <td><var>file, mode</var>)</td></tr></table></dt>
<dd>
A synonym for <tt class="function">open</tt>, maintained for backwards compatibility.
</dl>

<p>
The <tt class="module">sunau</tt> module defines the following exception:

<p>
<dl><dt><b><span class="typelabel">exception</span>&nbsp;<tt id='l2h-4564' xml:id='l2h-4564' class="exception">Error</tt></b></dt>
<dd>
An error raised when something is impossible because of Sun AU specs or 
implementation deficiency.
</dd></dl>

<p>
The <tt class="module">sunau</tt> module defines the following data items:

<p>
<dl><dt><b><tt id='l2h-4565' xml:id='l2h-4565'>AUDIO_FILE_MAGIC</tt></b></dt>
<dd>
An integer every valid Sun AU file begins with, stored in big-endian
form.  This is the string "<tt class="samp">.snd</tt>" interpreted as an integer.
</dd></dl>

<p>
<dl><dt><b><tt id='l2h-4566' xml:id='l2h-4566'>AUDIO_FILE_ENCODING_MULAW_8</tt></b></dt>
<dd>
<dt><b><tt id='l2h-4568' xml:id='l2h-4568'>AUDIO_FILE_ENCODING_LINEAR_8</tt></b></dt><dd>
<dt><b><tt id='l2h-4569' xml:id='l2h-4569'>AUDIO_FILE_ENCODING_LINEAR_16</tt></b></dt><dd>
<dt><b><tt id='l2h-4570' xml:id='l2h-4570'>AUDIO_FILE_ENCODING_LINEAR_24</tt></b></dt><dd>
<dt><b><tt id='l2h-4571' xml:id='l2h-4571'>AUDIO_FILE_ENCODING_LINEAR_32</tt></b></dt><dd>
<dt><b><tt id='l2h-4572' xml:id='l2h-4572'>AUDIO_FILE_ENCODING_ALAW_8</tt></b></dt><dd>
Values of the encoding field from the AU header which are supported by
this module.
</dd></dl>

<p>
<dl><dt><b><tt id='l2h-4567' xml:id='l2h-4567'>AUDIO_FILE_ENCODING_FLOAT</tt></b></dt>
<dd>
<dt><b><tt id='l2h-4573' xml:id='l2h-4573'>AUDIO_FILE_ENCODING_DOUBLE</tt></b></dt><dd>
<dt><b><tt id='l2h-4574' xml:id='l2h-4574'>AUDIO_FILE_ENCODING_ADPCM_G721</tt></b></dt><dd>
<dt><b><tt id='l2h-4575' xml:id='l2h-4575'>AUDIO_FILE_ENCODING_ADPCM_G722</tt></b></dt><dd>
<dt><b><tt id='l2h-4576' xml:id='l2h-4576'>AUDIO_FILE_ENCODING_ADPCM_G723_3</tt></b></dt><dd>
<dt><b><tt id='l2h-4577' xml:id='l2h-4577'>AUDIO_FILE_ENCODING_ADPCM_G723_5</tt></b></dt><dd>
Additional known values of the encoding field from the AU header, but
which are not supported by this module.
</dd></dl>

<p>

<p><br /></p><hr class='online-navigation' />
<div class='online-navigation'>
<!--Table of Child-Links-->
<a name="CHILD_LINKS"><strong>Subsections</strong></a>

<ul class="ChildLinks">
<li><a href="au-read-objects.html">19.4.1 AU_read Objects</a>
<li><a href="au-write-objects.html">19.4.2 AU_write Objects</a>
</ul>
<!--End of Table of Child-Links-->
</div>

<div class="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="19.3 aifc  "
  href="module-aifc.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="19. multimedia Services"
  href="mmedia.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="19.4.1 au_read Objects"
  href="au-read-objects.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-aifc.html">19.3 aifc  </a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="mmedia.html">19. Multimedia Services</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="au-read-objects.html">19.4.1 AU_read Objects</a>
</div>
</div>
<hr />
<span class="release-info">Release 2.5.1, documentation updated on 18th April, 2007.</span>
</div>
<!--End of Navigation Panel-->
<address>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</address>
</body>
</html>
